home *** CD-ROM | disk | FTP | other *** search
/ Apple Developer Connection Student Program / ADC Tools Sampler CD Disk 2 1999.iso / CodeWarrior Pro for Java / Third Party Documentation / Java Documentation / ZipSight / zipsight.txt < prev   
Text File  |  1998-08-24  |  8KB  |  173 lines
  1. ========================================================================
  2. Metrowerks ZipSight HTTP Server Release Notes 
  3. ========================================================================
  4.  
  5. Version: 1.1b5
  6. Date:    08/24/98
  7. Author:  Pedro Larios
  8. ========================================================================
  9.  
  10. This is the first release of the ZipSight application. This app
  11. is an http server that allows the user to view html docs inside a
  12. zip or jar file, preserving all the links within the docs. This is 
  13. particularly useful on the Mac where the filename limit of 31
  14. characters renders most javadoc documentation useless. However,
  15. since this application is 100% pure Java, it will (supposedly) run
  16. on any platform which has a 1.1 or later capable VM. It has been
  17. tested on Windows and Mac only.
  18.  
  19. When the application is launched, a window will come up which will
  20. have three buttons: "configure", "start", and "quit". Below the
  21. buttons are the server address and status information. 
  22.  
  23. The configure button brings up a configuration panel that allows the 
  24. user to specify the server path, server port number, and whether or not 
  25. ZipSight should keep a log of all http transactions.
  26.  
  27. The server path points to a directory on the host machine containing
  28. the zip/jar files. All http requests the server gets will be relative
  29. to this server path. For example, if the server receives an http 
  30. request of the form: 
  31.  
  32. http://127.0.0.1/foo/bar/MyDocs.zip/index.html
  33.  
  34. the server will look for the file MyDocs.zip in the path:
  35.  
  36. server_path/foo/bar/
  37.  
  38. IMPORTANT NOTE: Although http requests that attempt to go above the 
  39. server path (i.e. those of the form "http://127.0.0.1/../../file.html") 
  40. will always be denied (the server will return a "403 Forbidden" error 
  41. message), there are no other security mechanisms in this version of 
  42. ZipSight. Therefore, be careful not to run the server on an untrusted 
  43. network. And of course, make sure there are no files inside the
  44. server path which you don't want to make accessible to the network.
  45.  
  46. The server port is the port number on which the server listens for
  47. connections. By default, this is set to port 80 (the well-known
  48. port number for WWW-HTTP) but can be changed to any valid port number.
  49.  
  50. The check box marked "Log transactions" determines whether or not ZipSight 
  51. will keep a log of all server transactions. This log will be saved in
  52. a text file called "ZipSight.log" which will be created in the same folder 
  53. as the one the ZipSight application resides in.
  54.  
  55. The checkbox marked "Start server on launch" determines whether or not 
  56. the server should start when ZipSight is launched. This will use the
  57. current configuration settings for server path and port number so before
  58. setting this option make sure the server path is not pointing to some
  59. folder you do not wish to make visible on the network! If the server
  60. path is not specified in the zipsight.properties file, the path 
  61. defaults to the java user.dir property. Typically, this will be the folder
  62. where ZipSight resides.
  63.  
  64. On pressing the start button the server will begin listening for a
  65. connection on the port number specified in the configuration panel. The 
  66. status field should change from "stopped" to "running". The server address 
  67. field should show the machine's HTTP address. This field is not editable, 
  68. but it appears to let the user know what the server's address is. The text 
  69. from this field can be copied and pasted into a WWW-browser to specify 
  70. the correct URL.
  71.  
  72. Once the server is started, it is ready to begin serving http requests.
  73. Fire up your favorite WWW browser and enter the URL for the file(s) you
  74. wish to browse.
  75.  
  76. URLs to the server should be constructed as follows:
  77.  
  78. * to specify files within a zip:
  79.  
  80.   http://IP:PORT/path1/filename.zip/path2/filename.html
  81.  
  82.   IP:PORT is the address where the server is listening (displayed in the 
  83.   "Server address" field). 
  84.   
  85.   "path1" is the path to the file "filename.zip". This path will be 
  86.   appended to the server path by ZipSight in order to locate the file
  87.   "filename.zip". It is, of course, optional.
  88.   
  89.   "filename.zip" is the name of the zip/jar file to serve.
  90.   
  91.   "path2" is the path inside the zip/jar file used to find the html
  92.   document "filename.html".
  93.  
  94. * to specify files outside a zip:
  95.  
  96.   http://IP:PORT/path/filename.html
  97.  
  98. * If a filename is not specified, ZipSight will search for a default 
  99.   index inside the zip file (index.html). Thus, the following URL will 
  100.   display the file "index.html" located inside filename.zip.
  101.  
  102.   http://IP:PORT/filename.zip/
  103.  
  104.   If there is no "index.html" file within the zip file, ZipSight will 
  105.   generate an index of the contents of the zip file, with hyper links to 
  106.   all html files it finds inside the zip.
  107.   
  108. ========================================================================
  109. New Features in This Version
  110. ========================================================================
  111. 1.1
  112. * Added pref to autostart the server on launch.
  113.  
  114. * This version of ZipSight requires Swing version 1.0.3 or later. Make sure
  115.   the swing libraries reside in the Java VM's classpath before running the
  116.   application.
  117.   
  118. * ZipSight now saves the configuration options to disk in a file called
  119.   "zipsight.properties" so they can be remembered between sessions.
  120.   Currently, it saves only the following properties: screen position,
  121.   server port number, server home, whether logging should be enabled, and
  122.   whether or not the server should start as soon as ZipSight is launched.
  123.   The properties file is a text file so it can be edited by the user.
  124.   
  125. 1.0
  126. * N/A
  127.  
  128. ========================================================================
  129. Bugs Fixed in This Version
  130. ========================================================================
  131.  
  132. * 1.1b3 On Mac, it was not possible to copy the server address from the 
  133.   text field using cmd-C. Menu items have been added which enable the user
  134.   to select and copy this text. To do this, use "Edit->Select" and/or
  135.   "Edit->Copy". 
  136.  
  137. ========================================================================
  138. Known Bugs and Incompatibilities
  139.  
  140. ========================================================================
  141.  
  142. * MRJ2.1ea1 USERS BEWARE:
  143.   The "stop server" button has been disabled when using MRJ2.1ea1 due to 
  144.   a bug with this version of MRJ which will cause the VM to crash when 
  145.   the server socket is closed. This will go away when this bug is fixed 
  146.   in MRJ (hopefully soon).
  147.  
  148. ========================================================================
  149. Additional Notes
  150. ========================================================================
  151.  
  152. * As mentioned above, this application requires a 1.1 or greater VM. On
  153.   the Mac, you should use MRJ 2.0 or later.  It seems to work reasonably 
  154.   well with both MRJ 2.0 and the Pro 3 Metrowerks VM. On windows, JDK/JRE
  155.   version 1.1.6 is recommended.
  156.  
  157. ========================================================================
  158. Contacting Metrowerks
  159. ========================================================================
  160.  
  161. For bug reports, technical questions, and suggestions, please use the
  162. forms in the Release Notes folder on the CD, and send them to
  163.  
  164. support@metrowerks.com
  165.  
  166. See the CodeWarrior on the Nets document in the Release Notes folder for
  167. more contact information, including a list of Internet news groups, 
  168. on-line services, and patch and update sites.
  169.  
  170. ========================================================================
  171.  
  172. CodeWarrior Java Engineers
  173. Metrowerks Corporation